DSV API POE
Response Attributes
/getStatus
Method: POST
Content-Type: application/json
Response Attributes :
Body :
| Sno | Element | AttributeType | Format | Example | Description |
|---|---|---|---|---|---|
| 1 | totalRecordCount | Number | "totalRecordCount": 144 | Number of records matched based on the input | |
| 2 | recordsfetched | Number | "recordsFetched": 100 | Results fetched based on the input page size | |
| 3 | startIndex | Number | "startIndex": 1 | Index of the starting record in the response based on the value in request payload | |
| 4 | recordSetCompleteIndicator | Boolean | "recordSetCompleteIndicator": true | Flag indicating if the total no of records have been returned. If the value is false, call the service by changing the start index for incremental data. If the value is true, no need to call the service for incremental data. | |
| 5 | ciscoDSVLineID | Number | "ciscoDSVLineID": 1 | Identifies the unique record in response | |
| 6 | sourceXmlBookingId | String | "sourceXmlBookingId":"TEST229" | Distributor Xml Reference ID provided in the input | |
| 7 | sourceProfileId | Number | "sourceProfileId": 999 | Unique distributor source profile id in the input | |
| 8 | distiSoNumber | String | "distiSoNumber": "9999999AA" | Distributor Sales Order Number | |
| 9 | distiSoLineNumber | String | "distiSoLineNumber": "7" | Distributor Sales Order Line Number | |
| 10 | bookingsLineStatus | String | "bookingsLineStatus": "CLOSED" | Reflects the status of the booking transaction | |
| 11 | status | String | "status": "CHANGE" | Reflects whether the booking is New or Change | |
| 12 | netUnitPrice | Double | "netUnitPrice": 230.0 | Reflects the net unit price on the deal | |
| 13 | dealId | String | "dealId": "12345678" | Deal Id associated with the booking | |
| 14 | magicKey | String | "magicKey": "Q8656123456-999" | Magic Key associated with the Deal on the booking | |
| 15 | promoNumber | String | "promoNumber": "XX-VPL" | Reflects the Promotion Number | |
| 16 | expirationDate | Date | Date-Time | "expirationDate": "2022-01-31T00:00:00" | Booking Expiration Date. Timezone is in PST |
| 17 | extendedExpirationDate | Date | Date-Time | "extendedExpirationDate": "2022-05-12T00:00:00" | Booking Extended Expiration Date. Timezone is in PST |
| 18 | serviceQuoteNumber | String | "serviceQuoteNumber": "XX-VYI" | Reflects the Service Quote Number | |
| 19 | ciscoStandardPartNumber | String | "ciscoStandardPartNumber": "XX3300" | Reflects the Mfg Part Number / SKU | |
| 20 | productQuantity | Number | "productQuantity": 4 | DSV Booking Quantity associated with the SKU | |
| 21 | reportedNetUnitPrice | Double | "reportedNetUnitPrice": 174.62 | Reported Net Unit Price by the distributor on the booking in USD | |
| 22 | remainingQuantity | Number | "remainingQuantity": 4 | Remaining quantity on the deal for consumption | |
| 23 | claimPerUnit | Double | "claimPerUnit": 214.91 | Rebate submitted by distributor per unit | |
| 24 | wplPriceLc | Double | "wplPriceLc": 389.53 | Whole Sale Price List in local currency | |
| 25 | resellerToDistiPONumber | String | "resellerToDistiPONumber": "248146" | Reseller To Disti PO Number | |
| 26 | customerReqShipDate | String | Date-Time | "customerReqShipDate": "2021-10-15T00:00:00" | Customer Requested Ship Date. Timezone is in PST |
| 27 | buyerResellerName | String | "buyerResellerName": "INTERNAL BV" | Buyer/ Reseller Name associated with the booking | |
| 28 | buyerResellerPartnerIdentification | String | "buyerResellerPartnerIdentification": "535090" | Buyer / Reseller Partner Identification | |
| 29 | endCustomerName | String | "endCustomerName": "INTERNAL BV" | EndCustomer Name associated with the booking | |
| 30 | ciscoCreatedFlag | String | "ciscoCreatedFlag": "N" | Filter to control whether cisco created internal bookings to be included in API response or not. | |
| 31 | lineErrors | Array | lineErrors": [{ "errorId": "12345","errorMessage": "DSV Booking is having Magic Key but Deal ID or Quote Number is not provided"}] | Booking validation errors would be displayed |
/getDetails
Method: POST
Content-Type: application/json
Response Attributes :
Body :
| Sno | Element | AttributeType | Format | Example | Description |
|---|---|---|---|---|---|
| 1 | totalRecordCount | Number | "totalRecordCount": 144 | Number of records matched based on the input | |
| 2 | recordsfetched | Number | "recordsFetched": 100 | Results fetched based on the input page size | |
| 3 | startIndex | Number | "startIndex": 1 | Index of the starting record in the response based on the value in request payload | |
| 4 | recordSetCompleteIndicator | Boolean | "recordSetCompleteIndicator": true | Flag indicating if the total no of records have been returned. If the value is false, call the service by changing the start index for incremental data. If the value is true, no need to call the service for incremental data. | |
| 5 | ciscoDSVLineID | Number | "ciscoDSVLineID": 1 | Identifies the unique record in response | |
| 6 | sourceXmlBookingId | String | "sourceXmlBookingId":"TEST229" | Distributor Xml Reference ID provided in the input | |
| 7 | sourceProfileId | Number | "sourceProfileId": 999 | Unique distributor source profile id provided in the input | |
| 8 | distiSoNumber | String | "distiSoNumber": "9999999AA" | Distributor Sales Order Number | |
| 9 | distiSoLineNumber | String | "distiSoLineNumber": "7" | Distributor Sales Order Line Number | |
| 10 | bookingDate | String | Date-Time | "bookingDate": "2021-02-25T00:00:00" | Reflects the actual booking date in PST |
| 11 | distiResellerSoDate | String | Date-Time | "distiResellerSoDate": "2021-02-22T00:00:00" | Distributor to reseller sales order date in PST |
| 12 | startDate | String | Date-Time | "startDate": "2021-02-22T00:00:00" | Duration start date associated with the deal in PST |
| 13 | endDate | String | Date-Time | "endDate": "2021-02-22T00:00:00" | Duration end date associated with the deal in PST |
| 14 | duration | Double | "duration": 22 | Duration term associated with the deal | |
| 15 | reportedProductUnitPrice | Double | " reportedProductUnitPrice ": 22.09 | Reported Product Unit Price by the distributor on the booking in USD | |
| 16 | distiPoNumber | String | "distiPoNumber": "XX-VYI" | Distributor Purchase Order Number | |
| 17 | dropShip | String | "dropShip":"Y" | Indicates whether the booking is a drop ship or not | |
| 18 | buyerResellerAddress1 | String | "buyerResellerAddress1": "GR FL, TWR 3, DARLING PARK" | Describes buyer/reseller address1 | |
| 19 | buyerResellerAddress2 | String | " buyerResellerAddress2": "201 SUSSEX STREET" | Describes buyer/reseller address2 | |
| 20 | buyerResellerCity | String | "buyerResellerCity": "SYDNEY" | Describes buyer/reseller city | |
| 21 | buyerResellerState | String | "buyerResellerState": "SOUTHWALES" | Describes buyer/reseller state | |
| 22 | buyerResellerZip | String | "buyerResellerZip": "2000" | Describes buyer/reseller postal code/zip | |
| 23 | buyerResellerCountry | String | "buyerResellerCountry": "AU" | Describes buyer/reseller country | |
| 24 | endCustomerAddress1 | String | "endCustomerAddress1": "3-29 BIRNIE AVE" | Describes end customer address1 | |
| 25 | endCustomerAddress2 | String | "endCustomerAddress2": " U A3 " | Describes end customer address2 | |
| 26 | endCustomerCity | String | "endCustomerCity":"LIDCOMBE" | Describes end customer city | |
| 27 | endCustomerState | String | "endCustomerState": "NEW SOUTH WALES" | Describes end customer state | |
| 28 | endCustomerZip | String | "endCustomerZip": "2141" | Describes end customer postal code/zip | |
| 29 | endCustomerCountry | String | endCustomerCountry": "AU" | Describes end customer country | |
| 30 | ciscoCreatedFlag | String | "ciscoCreatedFlag": "N" | Filter to control whether cisco created internal bookings to be included in API response or not. |
/searchDSV
Method: POST
Content-Type: application/json
Response Attributes :
Body :
| Sno | Element | AttributeType | Format | Example | Description |
|---|---|---|---|---|---|
| 1 | totalRecordCount | Number | "totalRecordCount": 144 | Number of records matched based on the input | |
| 2 | recordsfetched | Number | "recordsFetched": 100 | Results fetched based on the input page size | |
| 3 | startIndex | Number | "startIndex": 1 | Index of the starting record in the response based on the value in request payload | |
| 4 | recordSetCompleteIndicator | Boolean | "recordSetCompleteIndicator": true | Flag indicating if the total no of records have been returned. If the value is false, call the service by changing the start index for incremental data. If the value is true, no need to call the service for incremental data. | |
| 5 | batchId | Number | "batchId": 1123 | batchId for the booking | |
| 6 | transId | Number | "transId": 1345 | transId for the booking | |
| 7 | distiSoNumber | String | "distiSoNumber": "9999999AA" | Distributor Sales Order Number | |
| 8 | distiSoLineNumber | String | "distiSoLineNumber": "7" | Distributor Sales Order Line Number | |
| 9 | sourceXmlBookingId | String | "sourceXmlBookingId":"TEST229" | Distributor Xml Reference ID provided in the input | |
| 10 | sourceProfileId | Number | "sourceProfileId": 999 | Unique distributor source profile id in the input | |
| 11 | dsvUniqueId | Number | "dsvUniqueId": 12345 | Reflects the unique id associated for booking | |
| 12 | ciscoStandardPartNumber | String | "ciscoStandardPartNumber": "C9115AX" | Reflects the part number | |
| 13 | productQuantity | Number | "productQuantity": 2 | Reflects the quantity of booking | |
| 14 | serviceQuoteNumber | String | "serviceQuoteNumber": "XX-VYI" | Reflects the Service Quote Number | |
| 15 | distiPoNumber | String | "distiPoNumber": "PO1233" | Distributor Purchase Order Number | |
| 16 | bookingsLineStatus | String | "bookingsLineStatus ": "CLOSED" | Reflects the status of the booking transaction | |
| 17 | dealId | String | "dealId": "12345678" | Deal Id associated with the booking | |
| 18 | reportedDealId | String | "reportedDealId": "52353102" | Reported Deal Id associated with the booking | |
| 19 | magicKey | String | "magicKey": "Q8656123456-999" | Magic Key associated with the Deal on the booking | |
| 20 | promoNumber | String | "promoNumber": "XX-VPL" | Reflects the Promotion Number | |
| 21 | expirationDate | String | Date | "expirationDate": "07-Feb-2022" | Booking Expiration Date. |
| 22 | extendedExpirationDate | String | Date | "extendedExpirationDate": "07-Feb-2022" | Booking Extended Expiration Date. |
| 23 | postedDate | String | Date | "postedDate": "07-Feb-2022" | Posted Date. |
| 24 | currency | String | "currency": "USD" | Reflects the currency in USD. | |
| 25 | reportedNetUnitPrice | Double | "netPrice": 392.12 | Reported Net Unit Price by the distributor on the booking in USD. | |
| 26 | reportedProductUnitPrice | Double | "unitPrice": 784 | Reported Unit Price by the distributor on the booking in USD. | |
| 27 | resellerToDistiPONumber | String | "resellerToDistiPONumber": "34302" | Reseller Purchase order number. | |
| 28 | d2DFlag | String | "d2DFlag": "N" | Reflects the d2d flag. | |
| 29 | fileReceivedDate | String | Date | "fileReceivedDate": "07-Feb-2022" | File Received Date. |
| 30 | ciscoBookDate | String | Date | "ciscoBookDate": "07-Feb-2022" | Submission Date |
| 31 | ciscoValidatedWplPrice | Double | "ciscoValidatedWplPrice": 784.23 | Reflects the cisco validated whole sale price on the deal | |
| 32 | ciscoValidatedUnitNetPrice | Double | "ciscoValidatedUnitNetPrice": 392.12 | Reflects the cisco validated unit net price on the deal | |
| 33 | theatre | String | "theatre": "USA" | Reflects the theatre | |
| 34 | distributor | String | "distributor": "Data" | Reflects the distributor name | |
| 35 | buyerResellerName | String | "buyerResellerName": "UNIFIED EXAMPLE" | Reseller Name associated with the booking | |
| 36 | buyerResellerAddress1 | String | "buyerResellerAddress1": "UNIFIED EXAMPLE" | Reseller Address1 associated with the booking | |
| 37 | buyerResellerAddress2 | String | "buyerResellerAddress2": "SCORPIUS" | Reseller Address2 associated with the booking | |
| 38 | buyerResellerCity | String | "buyerResellerCity": "SCHIPHOL" | Reseller city associated with the booking | |
| 39 | buyerResellerState | String | "buyerResellerState": "NH" | Reseller state associated with the booking | |
| 40 | buyerResellerZip | String | "buyerResellerZip": "11189A" | Reseller zip associated with the booking | |
| 41 | buyerResellerCountry | String | "buyerResellerCountry": "NL" | Reseller country associated with the booking | |
| 42 | endCustomerName | String | "endCustomerName": "HEALTH" | EndCustomer Name associated with the booking | |
| 43 | endCustomerAddress1 | String | "endCustomerAddress1": "HEALTH" | EndCustomer Address1 associated with the booking | |
| 44 | endCustomerAddress2 | String | "endCustomerAddress2": "HEALTH" | EndCustomer Address2 associated with the booking | |
| 45 | endCustomerCity | String | "endCustomerCity": "HEALTH" | EndCustomer city associated with the booking | |
| 46 | endCustomerState | String | "endCustomerState": "HEALTH" | EndCustomer state associated with the booking | |
| 47 | endCustomerZip | String | "endCustomerZip": "HEALTH" | EndCustomer zip associated with the booking | |
| 48 | endCustomerCountry | String | "endCustomerCountry": "HEALTH" | EndCustomer country associated with the booking | |
| 49 | webOrderId | String | "webOrderId": "1234" | Reflects the weborder id associated with booking | |
| 50 | fileName | String | "fileName": "example.txt" | Bookings submitted file name | |
| 51 | ciscoSoNumber | String | "ciscoSoNumber": "12345" | Reflects the ciscoSoNumber | |
| 52 | customerReqShipDate | String | Date | "customerReqShipDate": "07-Feb-2022" | customerReqShipDate |
| 53 | ciscoCreatedFlag | String | "ciscoCreatedFlag": "N" | Reflects the Cisco created or disti created | |
| 54 | wplPriceLc | Double | "wplPriceLc": 1222.89 | Reflects the wplPriceLc | |
| 55 | claimPerUnit | Double | "claimPerUnit": 1344.78 | Reflects the claimPerUnit | |
| 56 | netUnitPrice | Double | "netUnitPrice": 1456.89 | Reflects the netUnitPrice | |
| 57 | remainingQuantity | Number | "remainingQuantity": 3 | Reflects the remainingQuantity | |
| 58 | buyerResellerPartnerIdentification | String | "buyerResellerPartnerIdentification": "12345" | Reflects the buyerResellerPartnerIdentification | |
| 59 | distiResellerSoDate | String | Date | "distiResellerSoDate": "07-Feb-2022" | Reflects the distiResellerSoDate |
| 60 | dropShip | String | "dropShip": "N" | Reflects the dropship flag | |
| 61 | status | String | "status": "NEW" | Reflects the booking event | |
| 62 | startDate | String | Date | "startDate": "07-Feb-2022" | Reflects the start date |
| 63 | endDate | String | Date | "endDate": "07-Feb-2022" | Reflects the end Date |
| 64 | bookingDate | String | Date | "bookingDate": "07-Feb-2022" | Reflects the cisco booking Date |
| 65 | duration | Number | "duration": 36 | Reflects the duration | |
| 66 | ciscoDSVLineID | Number | "ciscoDSVLineID": 1 | Reflects the ciscoDSVLineID | |
| 67 | lineErrors | Array | "lineErrors": [{"errorId": 1, "errorMessage":Quantity exceeds the quantity available in Deal ID"}] | Reflects the errormessage for the bookings |